Micron Document
🎖️GitЯра🎖️


Displaying Raw • Download

feature/settings/src/commonTest/kotlin/org/meshtastic/feature/settings/debugging/LogFormatterTest.kt baef2a594d02337a0914df2f9e3782ec07d68195 (baef2a59) Text, 6.98 KB

T8b949e/*
* Copyright (c) 2026 Meshtastic LLC
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
Tff7b72package T7ee787org.meshtastic.feature.settings.debugging

Tff7b72import T7ee787kotlin.test.Test
Tff7b72import T7ee787kotlin.test.assertFalse
Tff7b72import T7ee787kotlin.test.assertTrue

Tff7b72class T56d364LogFormatterTest Tb4b4b4{

T8b949e/** A 32-byte channel PSK as it appears in hex inside a serialised AdminMessage. */
Tff7b72private Tff7b72val Te6edf3pskHex Tff7b72= Ta5d6ff"Ta5d6ffc9ee13385d82a7ccf1163b6085aacff4193e6388add2f71c41668bb0d5fa1f44Ta5d6ff"

Tff7b72private Tff7b72fun Td2a8fflogTb4b4b4(Te6edf3logMessageTb4b4b4: Tffa657StringTb4b4b4, Te6edf3decodedPayloadTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4) Tff7b72= Te6edf3DebugViewModelTb4b4b4.Te6edf3UiMeshLogTb4b4b4(
Te6edf3uuid Tff7b72= Ta5d6ff"Ta5d6ff1Ta5d6ff"Tb4b4b4,
Te6edf3messageType Tff7b72= Ta5d6ff"Ta5d6ffAdminTa5d6ff"Tb4b4b4,
Te6edf3formattedReceivedDate Tff7b72= Ta5d6ff"Ta5d6ff2026-03-25Ta5d6ff"Tb4b4b4,
Te6edf3logMessage Tff7b72= Te6edf3logMessageTb4b4b4,
Te6edf3decodedPayload Tff7b72= Te6edf3decodedPayloadTb4b4b4,
Tb4b4b4)

Tff7b72private Tff7b72fun Td2a8ffexportTb4b4b4(Tff7b72vararg Te6edf3logsTb4b4b4: Te6edf3DebugViewModelTb4b4b4.Te6edf3UiMeshLogTb4b4b4)Tb4b4b4: Tffa657String Tff7b72=
Te6edf3StringBuilderTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3also Tb4b4b4{ Te6edf3formatLogsToTb4b4b4(Tffa657itTb4b4b4, Te6edf3logsTb4b4b4.Te6edf3toListTb4b4b4(Tb4b4b4)Tb4b4b4) Tb4b4b4}Tb4b4b4.Te6edf3toStringTb4b4b4(Tb4b4b4)

Tf0883e@Test
Tff7b72fun Td2a8ff`export suppresses payload hex in okio's truncated form`Tb4b4b4(Tb4b4b4) Tb4b4b4{
T8b949e// okio renders a ByteString longer than 64 bytes as `[size=N hex=<first 64 bytes>…]`, NOT `[hex=..]`. A real
T8b949e// set_channel / get_channel_response AdminMessage exceeds 64 bytes and the PSK lands inside that prefix, so
T8b949e// this is the shape that actually carries the key on the export path.
Tff7b72val Te6edf3result Tff7b72= Te6edf3exportTb4b4b4(Te6edf3logTb4b4b4(Ta5d6ff"Ta5d6ffData{portnum=ADMIN_APP, payload=[size=75 hex=1a3f080112391220Tffd700$Te6edf3pskHexTa5d6ff…]}Ta5d6ff"Tb4b4b4)Tb4b4b4)

Te6edf3assertFalseTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Te6edf3pskHexTb4b4b4)Tb4b4b4, Ta5d6ff"Ta5d6ffthe channel key must not survive export in the truncated formTa5d6ff"Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffpayload=<suppressed>Ta5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffportnum=ADMIN_APPTa5d6ff"Tb4b4b4)Tb4b4b4, Ta5d6ff"Ta5d6ffsurrounding structure is keptTa5d6ff"Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`export suppresses payload hex regardless of the byte count`Tb4b4b4(Tb4b4b4) Tb4b4b4{
T8b949e// Guard the boundary between okio's two binary renderings rather than one example length.
Te6edf3listOfTb4b4b4(
Ta5d6ff"Ta5d6ffpayload=[hex=Tffd700$Te6edf3pskHexTa5d6ff]Ta5d6ff"Tb4b4b4,
Ta5d6ff"Ta5d6ffpayload=[size=32 hex=Tffd700$Te6edf3pskHexTa5d6ff]Ta5d6ff"Tb4b4b4,
Ta5d6ff"Ta5d6ffpayload=[size=140 hex=Tffd700$Te6edf3pskHexTa5d6ff…]Ta5d6ff"Tb4b4b4,
Ta5d6ff"Ta5d6ffpayload=[size=1024 hex=Tffd700$Te6edf3pskHexTa5d6ff…]Ta5d6ff"Tb4b4b4,
Tb4b4b4)
Tb4b4b4.Te6edf3forEach Tb4b4b4{ Te6edf3field Tff7b72-Tff7b72>
Tff7b72val Te6edf3result Tff7b72= Te6edf3exportTb4b4b4(Te6edf3logTb4b4b4(Ta5d6ff"Ta5d6ffData{portnum=ADMIN_APP, Tffd700$Te6edf3fieldTa5d6ff, want_response=true}Ta5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertFalseTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Te6edf3pskHexTb4b4b4)Tb4b4b4, Ta5d6ff"Ta5d6ffkey survived export for 'Tffd700$Te6edf3fieldTa5d6ff'Ta5d6ff"Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffwant_response=trueTa5d6ff"Tb4b4b4)Tb4b4b4, Ta5d6ff"Ta5d6fflater fields preserved for 'Tffd700$Te6edf3fieldTa5d6ff'Ta5d6ff"Tb4b4b4)
Tb4b4b4}
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`the per-entry copy action is sanitised like the export`Tb4b4b4(Tb4b4b4) Tb4b4b4{
T8b949e// The copy button sits next to the export and its output gets pasted into the same public issue trackers, so it
T8b949e// must not be a way around the redaction. Binds the real code path, not just the helper.
Tff7b72val Te6edf3copied Tff7b72=
Te6edf3formatLogEntryForCopyTb4b4b4(
Te6edf3logTb4b4b4(
Te6edf3logMessage Tff7b72= Ta5d6ff"Ta5d6ffData{portnum=ADMIN_APP, payload=[size=75 hex=1a3f080112391220Tffd700$Te6edf3pskHexTa5d6ff…]}Ta5d6ff"Tb4b4b4,
Te6edf3decodedPayload Tff7b72= Ta5d6ff"Ta5d6ffsettings=ChannelSettings{psk=[hex=Tffd700$Te6edf3pskHexTa5d6ff], name=LongFast}Ta5d6ff"Tb4b4b4,
Tb4b4b4)Tb4b4b4,
Tb4b4b4)

Te6edf3assertFalseTb4b4b4(Te6edf3copiedTb4b4b4.Te6edf3containsTb4b4b4(Te6edf3pskHexTb4b4b4)Tb4b4b4, Ta5d6ff"Ta5d6ffthe channel key must not reach the clipboardTa5d6ff"Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3copiedTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffpayload=<suppressed>Ta5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3copiedTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffpsk=<redacted>Ta5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3copiedTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffname=LongFastTa5d6ff"Tb4b4b4)Tb4b4b4, Ta5d6ff"Ta5d6ffnon-sensitive fields are keptTa5d6ff"Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`structured psk redaction covers okio's long and short forms`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Te6edf3listOfTb4b4b4(Ta5d6ff"Ta5d6ffpsk=[hex=Tffd700$Te6edf3pskHexTa5d6ff]Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffpsk=[size=140 hex=Tffd700$Te6edf3pskHexTa5d6ff…]Ta5d6ff"Tb4b4b4)Tb4b4b4.Te6edf3forEach Tb4b4b4{ Te6edf3field Tff7b72-Tff7b72>
Tff7b72val Te6edf3result Tff7b72= Te6edf3exportTb4b4b4(Te6edf3logTb4b4b4(Ta5d6ff"Ta5d6ffAdminMessageTa5d6ff"Tb4b4b4, Te6edf3decodedPayload Tff7b72= Ta5d6ff"Ta5d6ffsettings=ChannelSettings{Tffd700$Te6edf3fieldTa5d6ff, name=X}Ta5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertFalseTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Te6edf3pskHexTb4b4b4)Tb4b4b4, Ta5d6ff"Ta5d6ffkey survived for 'Tffd700$Te6edf3fieldTa5d6ff'Ta5d6ff"Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffname=XTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`formatLogsTo formats and redacts correctly`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Tff7b72val Te6edf3logs Tff7b72=
Te6edf3listOfTb4b4b4(
Te6edf3DebugViewModelTb4b4b4.Te6edf3UiMeshLogTb4b4b4(
Te6edf3uuid Tff7b72= Ta5d6ff"Ta5d6ff1Ta5d6ff"Tb4b4b4,
Te6edf3messageType Tff7b72= Ta5d6ff"Ta5d6ffPacketTa5d6ff"Tb4b4b4,
Te6edf3formattedReceivedDate Tff7b72= Ta5d6ff"Ta5d6ff2026-03-25Ta5d6ff"Tb4b4b4,
Te6edf3logMessage Tff7b72= Ta5d6ff"Ta5d6ffHelloTa5d6ff"Tb4b4b4,
Te6edf3decodedPayload Tff7b72= Ta5d6ff"Ta5d6ffsession_passkey: secretTa5d6ff\Ta5d6ffnother: valueTa5d6ff"Tb4b4b4,
Tb4b4b4)Tb4b4b4,
Tb4b4b4)
Tff7b72val Te6edf3out Tff7b72= Te6edf3StringBuilderTb4b4b4(Tb4b4b4)
Te6edf3formatLogsToTb4b4b4(Tff7b72outTb4b4b4, Te6edf3logsTb4b4b4)

Tff7b72val Te6edf3result Tff7b72= Tff7b72outTb4b4b4.Te6edf3toStringTb4b4b4(Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ff2026-03-25 [Packet]Ta5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffHelloTa5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffsession_passkey:<redacted>Ta5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffother: valueTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`export redacts the real proto equals-and-hex payload format`Tb4b4b4(Tb4b4b4) Tb4b4b4{
T8b949e// Matches what the decoded payload actually looks like (proto toString uses '=' and '[hex=..]').
Tff7b72val Te6edf3logs Tff7b72=
Te6edf3listOfTb4b4b4(
Te6edf3DebugViewModelTb4b4b4.Te6edf3UiMeshLogTb4b4b4(
Te6edf3uuid Tff7b72= Ta5d6ff"Ta5d6ff1Ta5d6ff"Tb4b4b4,
Te6edf3messageType Tff7b72= Ta5d6ff"Ta5d6ffAdminTa5d6ff"Tb4b4b4,
Te6edf3formattedReceivedDate Tff7b72= Ta5d6ff"Ta5d6ff2026-03-25Ta5d6ff"Tb4b4b4,
Te6edf3logMessage Tff7b72= Ta5d6ff"Ta5d6ffAdminMessageTa5d6ff"Tb4b4b4,
Te6edf3decodedPayload Tff7b72= Ta5d6ff"Ta5d6ffsession_passkey=[hex=dd8042fa0cfd7d17], region=USTa5d6ff"Tb4b4b4,
Tb4b4b4)Tb4b4b4,
Tb4b4b4)
Tff7b72val Te6edf3out Tff7b72= Te6edf3StringBuilderTb4b4b4(Tb4b4b4)
Te6edf3formatLogsToTb4b4b4(Tff7b72outTb4b4b4, Te6edf3logsTb4b4b4)

Tff7b72val Te6edf3result Tff7b72= Tff7b72outTb4b4b4.Te6edf3toStringTb4b4b4(Tb4b4b4)
Te6edf3assertFalseTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffdd8042fa0cfd7d17Ta5d6ff"Tb4b4b4)Tb4b4b4, Ta5d6ff"Ta5d6ffthe hex secret must not survive exportTa5d6ff"Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffsession_passkey=<redacted>Ta5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffregion=USTa5d6ff"Tb4b4b4)Tb4b4b4, Ta5d6ff"Ta5d6ffnon-sensitive fields are keptTa5d6ff"Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`appendLogcat redacts sensitive keys and keeps other lines`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Tff7b72val Te6edf3out Tff7b72= Te6edf3StringBuilderTb4b4b4(Tb4b4b4)
Te6edf3appendLogcatTb4b4b4(Tff7b72outTb4b4b4, Ta5d6ff"Ta5d6ffI/foo: hello worldTa5d6ff\Ta5d6ffnD/bar: private_key: deadbeefTa5d6ff"Tb4b4b4)

Tff7b72val Te6edf3result Tff7b72= Tff7b72outTb4b4b4.Te6edf3toStringTb4b4b4(Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffApp LogcatTa5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffI/foo: hello worldTa5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffprivate_key:<redacted>Ta5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}

Tf0883e@Test
Tff7b72fun Td2a8ff`redactText redacts keys across lines and keeps the rest`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Tff7b72val Te6edf3result Tff7b72= Te6edf3redactTextTb4b4b4(Ta5d6ff"Ta5d6ffD/x: session_passkey=[hex=dd8042fa0cfd7d17]Ta5d6ff\Ta5d6ffnD/x: region=USTa5d6ff\Ta5d6ffnD/x: private_key: bbTa5d6ff"Tb4b4b4)

Te6edf3assertFalseTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffdd8042fa0cfd7d17Ta5d6ff"Tb4b4b4)Tb4b4b4, Ta5d6ff"Ta5d6ffhex secret must not surviveTa5d6ff"Tb4b4b4)
Te6edf3assertFalseTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ff: bbTa5d6ff"Tb4b4b4)Tb4b4b4, Ta5d6ff"Ta5d6ffbare-token secret must not surviveTa5d6ff"Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffsession_passkey=<redacted>Ta5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffprivate_key:<redacted>Ta5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertTrueTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6ffregion=USTa5d6ff"Tb4b4b4)Tb4b4b4)
Tb4b4b4}
Tb4b4b4}

Served by rngit 1.5.0 - Generated in 0.06s